Skip to main content
Version: 1.0.2

Request For Payment Outbound

The RequestForPayment API enables to request for a payment from the sender.

Method: POST​

{{URL}}/PLMASTER/rpc/paymentv2

Headers​

NameValue
Content-Typeapplication/json

Example​

Payload Parameters
ParameterDescription

notes

Optional

String

Description or note related to the payment

Example – "Salary12478"

product

Mandatory

String

Type of product

Example – "PL"

program

Mandatory

String

program associated with the payment

Example – "100000000541001"

transactionDateTime

Optional

String

date and time of the transaction

Example – "2021-12-23 12:33:41"

channel

Mandatory

String

Channel through which the transaction was made

Example – "CLEARING_HOUSE" or "FED_NOW"

transactionType

Mandatory

String

Type of transaction

Example – "RTP_RFP_OUT" or "FEDNOW_RFP_OUT"

reference

Mandatory

String

reference for the transaction

Example – "reference"

transactionAmount

Mandatory

Object

amount

Mandatory

String

Amount of transaction

Example – "91"

currency

Mandatory

String

Code of the currency type in which the transaction is initiated

Example – "USD"

paymentInfo

Optional

Object

expDate

Optional

String

Expiry date of the payment to be made

Example – "2024-04-09"

processor

Optional

String

Processor to which the payment channel is aligned for transaction

Example – "TCH" or "FED_NOW"

senderType

Optional

String

Type of customer

Example – "BUSINESS"

debtorAccount

Mandatory

Object

institution

Mandatory

Object

identification

Mandatory

String

Identification of the sender's bank or financial institution

Example – "234567891"

name

Optional

String

Name of the sender's bank or financial institution

Example – "TCH"

identificationType

Mandatory

String

Type of identification used for bank or financial institution

Example – "ABA"

identification

Mandatory

String

Account identification of sender

Example – "652543123165"

identificationType

Mandatory

String

Type of identification used for sender account

Example – "ACCOUNT_NUMBER"

debtor

Mandatory

Object

firstName

Mandatory

String

Sender's first name

Example – "fayaz"

lastName

Optional

String

Sender's first name

Example – "Saeed"

Identification

Optional

String

Sender's identification

Example – "134222322"

middleName

Optional

String

Sender's middle name

Example – ""

identificationType

Optional

String

Type of identification used

Example – "SSN"

userType

Optional

String

Type of account holder

Example – "INDIVIDUAL"

creditorAccount

Mandatory

Object

institution

Optional

Object

identification

Optional

String

Identification of the receiver's bank or financial institution

Example – "101115399"

name

Optional

String

Name of the receiver's bank or financial institution

Example – "ITALBANK"

identificationType

Optional

String

Type of identification used for bank or financial institution

Example – "ABA"

identification

Mandatory

String

Account identification of receiver

Example – "200812498478915"

identificationType2

Optional

String

Additional type of identification used

Example – "CHECKING"

identificationType

Mandatory

String

Type of identification used for receiver account

Example – "ACCOUNT_NUMBER"

creditor

Mandatory

Object

firstName

Mandatory

String

Receiver's first name

Example – "Hafiz"

lastName

Optional

String

Receiver's first name

Example – "Saeed"

Identification

Optional

String

Receiver's identification

Example – "254178554"

middleName

Optional

String

Receiver's middle name

Example – ""

identificationType

Optional

String

Type of identification used

Example – "SSN"

userType

Mandatory

String

Type of account holder

Example – "INDIVIDUAL"

creditorContact

Mandatory

Object

primaryPhone

Mandatory

String

Primary contact number of receiver

Example – "1253674563"

primaryEmail

Mandatory

String

Primary email address of receiver

Example – "steve-woz@rtp-tp.com"

creditorPostalAddress

Mandatory

Object

zipCode

Mandatory

String

Zipcode of receiver's address

Example – "66614"

city

Optional

String

City of receiver's address

Example – "Topeka"

addressType

Optional

String

Type of address

Example – "HOUSE"

countryCode

Mandatory

String

Country code of receiver's address

Example – "840"

addressLine1

Mandatory

String

First line of address

Example – "2745 SW cross VILLA WEST"

addressLine2

Optional

String

Second line of address

Example – "304 street"

State

Optional

String

State of receiver's address

Example – "KS"


curl --location '{{URL}}/PLMASTER/rpc/paymentv2' \
--header 'Content-Type: application/json' \
--data-raw '{"notes":"Salary12478","product":"PL","program":"100000000541001","transactionDateTime":"2021-12-23 12:33:41","channel":"CLEARING_HOUSE","transactionType":"RTP_RFP_OUT","reference":"{{reference}}","transactionAmount":{"amount":"200","currency":"USD"},"paymentInfo":{"expDate":"2024-04-09"},"processor":"TCH","senderType":"BUSINESS","debtorAccount":{"institution":{"identification":"234567891","name":"TCH","identificationType":"ABA"},"identification":"652543123165","identificationType":"ACCOUNT_NUMBER"},"debtor":{"firstName":"fayaz","lastName":"Saeed","identification":"134222322","middleName":"","identificationType":"SSN","userType":"INDIVIDUAL"},"creditorAccount":{"institution":{"identification":"101115399","name":"ITALBANK","identificationType":"ABA"},"identification":"200812498478915","identificationType2":"CHECKING","identificationType":"ACCOUNT_NUMBER"},"creditor":{"firstName":"Hafiz","lastName":"Saeed","identification":"254178554","middleName":"","identificationType":"SSN","userType":"INDIVIDUAL"},"creditorContact":{"primaryPhone":"1253674563","primaryEmail":"steve-woz@rtp-tp.com"},"creditorPostalAddress":{"zipCode":"66614","city":"Topeka","addressType":"HOUSE","countryCode":"840","addressLine1":"2745 SW cross VILLA WEST","addressLine2":"304 street","state":"KS"}}'

Request Body (Applicable for both FedNow and RTP)​


{
    "notes": "Salary12478",
    "product": "PL",
    "program": "100000000541001",
    "transactionDateTime": "2021-12-23 12:33:41",
    "channel": "CLEARING_HOUSE",
    "transactionType": "RTP_RFP_OUT",
    "reference": "{{reference}}",
    "transactionAmount": {
        "amount": "200",
        "currency": "USD"
    },
    "paymentInfo": {
        "expDate": "2024-04-09"
    },
    "processor": "TCH",
    "senderType": "BUSINESS",
    "debtorAccount": {
        "institution": {
            "identification": "234567891",
            "name": "TCH",
            "identificationType": "ABA"
        },
        "identification": "652543123165",
        "identificationType": "ACCOUNT_NUMBER"
    },
    "debtor": {
        "firstName": "fayaz",
        "lastName": "Saeed",
        "identification": "134222322",
        "middleName": "",
        "identificationType": "SSN",
        "userType": "INDIVIDUAL"
    },
    "creditorAccount": {
        "institution": {
            "identification": "101115399",
            "name": "ITALBANK",
            "identificationType": "ABA"
        },
        "identification": "200812498478915",
        "identificationType2": "CHECKING",
        "identificationType": "ACCOUNT_NUMBER"
    },
    "creditor": {
        "firstName": "Hafiz",
        "lastName": "Saeed",
        "identification": "254178554",
        "middleName": "",
        "identificationType": "SSN",
        "userType": "INDIVIDUAL"
    },
    "creditorContact": {
        "primaryPhone": "1253674563",
        "primaryEmail": "steve-woz@rtp-tp.com"
    },
    "creditorPostalAddress": {
        "zipCode": "66614",
        "city": "Topeka",
        "addressType": "HOUSE",
        "countryCode": "840",
        "addressLine1": "2745 SW cross VILLA WEST",
        "addressLine2": "304 street",
        "state": "KS"
    }
}

Response: 200​

Response Parameters
ParameterDescription

id

String

Unique identifier of the request

Example – "1"

result

Object

api

Object

type

String

Type of transaction

Example – "RTP_RFP_OUT_ACK"

reference

String

Unique reference number of transaction

Example – "1712637083888"

dateTime

String

Date and time of the transaction

Example – "2024-04-09 04:31:26"

account

Object

accountId

String

Account number of the account

Example – "200812498478915"

balanceCents

Number

Balance amount of the account in cents

Example – 123144041997035

holdBalanceCents

Number

Balance amount that should be held in the account

Example – 200

status

String

Current status of the account

Example – "ACTIVE"

transactionNumber

String

Unique identifier of the transaction

Example – "QA00000003415001"

transactionStatus

String

Current status of the transaction

Example – "PENDING"

originalRequestBase64

String

Base64 code representing original transaction request

Example – "Base64 Value of Original Request"

processId

String

Unique identifier of the whole transaction process

Example – "20240409043320000CBPL24040903320002"

header

Object

reference

String

Reference ID of the response

Example – "1712637198835"

apiKey

String

API key used for identification

Example – "cab8137f45ac44d7904164d1d14211bd"

signature

String

API response digital signature

Example – "MEQCIEei/yWRD+X4l8NvwLB8LcZC9HoQNpxyeN5k3rbJETW/AiAOddOQmxLOTQGmFCLGzVSkWwGKxWwg747HAksrTyqP5Q=="

Response Body (Applicable for both FedNow and RTP)​


{
  "id": "1",
  "result": {
    "api": {
      "type": "RTP_RFP_OUT_ACK",
      "reference": "1712637083888",
      "dateTime": "2024-04-09 04:31:26"
    },
    "account": {
      "accountId": "200812498478915",
      "balanceCents": 123144041997035,
      "holdBalanceCents": 200,
      "status": "ACTIVE"
    },
    "transactionNumber": "QA00000003415001",
    "transactionStatus": "PENDING",
    "originalRequestBase64": "Base64 Value of Original Request",
    "processId": "20240409043126000CBPL24040903320001"
  },
  "header": {
    "reference": "1712637083888",
    "apiKey": "cab8137f45ac44d7904164d1d14211bd",
    "signature": "MEQCIG/+EDUNzpBhWA4JmZUMMqGFOSdFU4Q4OSwhu8oTV43UAiAIYH2mcd8JnC0D1/08zPj4Ll5AOSmC5WZP8y6Qpc5WWw=="
  }
}